feat(input_schema): Add enumSuggestedValues property to input schema #569
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mfori
added
the
t-console
github-actions
bot
added
the
tested
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for the enumSuggestedValues property to input schemas, providing an alternative to enum that allows custom values while providing UI suggestions.
Key changes:
- Added
enumSuggestedValuesproperty that acts as UI hints without enforcing validation - Extended
stringPropertyandsubSchemaStringPropertyto supporteditor: 'select'withenumSuggestedValues - Updated
arrayItemsSelectto support eitherenumorenumSuggestedValues(mutually exclusive) - Comprehensive test coverage for both string and array properties with various edge cases
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
test/input_schema.test.ts |
Added 13 comprehensive test cases covering enumSuggestedValues usage with string and array properties, validation of mutual exclusivity with enum, and editor requirements |
packages/json_schemas/schemas/input.schema.json |
Added select editor support to stringProperty and subSchemaStringProperty with conditional enumSuggestedValues requirement; updated arrayItemsSelect to use oneOf for enum/enumSuggestedValues exclusivity; reordered editor enums consistently |
packages/input_schema/src/types.ts |
Added enumSuggestedValues property to StringFieldDefinition type |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
valekjo
approved these changes
Nov 13, 2025
Member
valekjo
left a comment
valekjo
left a comment
There was a problem hiding this comment.
Input schema is getting pimped up :)
We'll need eat and learn on the new features
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Solves https://github.com/apify/apify-core/issues/24101 - adds support for
enumSuggestedValuesproperty, that can be used instead ofenumand it:I put this to
stringProperty, accepting nowselecteditor (only ifenumSuggestedValuesis specified), because it supports also other validation keywords (pattern,...) which makes totally sense to put another constraints on the custom value. (But there's no reason to allow these additional validation keywords when usingenum.)Other things works still the same
enumcan be defined only ifeditoris not defined or isselectenumSuggestedValuescan be defined only ifeditorisselect.enumorenumSuggestedValuescan (must) be defined ifeditorisselectDraft with changes to make this work in UI is ready here: https://github.com/apify/apify-core/pull/24164